﻿// This source code is dual-licensed under the Apache License, version
// 2.0, and the Mozilla Public License, version 1.1.
//
// The APL v2.0:
//
//---------------------------------------------------------------------------
//   Copyright (c) 2007-2016 Pivotal Software, Inc.
//
//   Licensed under the Apache License, Version 2.0 (the "License");
//   you may not use this file except in compliance with the License.
//   You may obtain a copy of the License at
//
//       https://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS,
//   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//   See the License for the specific language governing permissions and
//   limitations under the License.
//---------------------------------------------------------------------------
//
// The MPL v1.1:
//
//---------------------------------------------------------------------------
//  The contents of this file are subject to the Mozilla Public License
//  Version 1.1 (the "License"); you may not use this file except in
//  compliance with the License. You may obtain a copy of the License
//  at https://www.mozilla.org/MPL/
//
//  Software distributed under the License is distributed on an "AS IS"
//  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
//  the License for the specific language governing rights and
//  limitations under the License.
//
//  The Original Code is RabbitMQ.
//
//  The Initial Developer of the Original Code is Pivotal Software, Inc.
//  Copyright (c) 2007-2016 Pivotal Software, Inc.  All rights reserved.
//---------------------------------------------------------------------------

using RabbitMQ.Client.Events;
using System;
using System.Collections;

namespace RabbitMQ.Client.MessagePatterns
{
    ///<summary>Manages a subscription to a queue.</summary>
    ///<remarks>
    ///<para>
    /// This interface is provided to make creation of test doubles
    /// for <see cref="Subscription" /> easier.
    ///</para>
    ///</remarks>
    public interface ISubscription : IEnumerable, IEnumerator, IDisposable
    {
        void Ack();
        void Ack(BasicDeliverEventArgs evt);
        void Close();
        IBasicConsumer Consumer { get; }
        string ConsumerTag { get; }
        BasicDeliverEventArgs LatestEvent { get; }
        IModel Model { get; }
        void Nack(BasicDeliverEventArgs evt, bool multiple, bool requeue);
        void Nack(bool multiple, bool requeue);
        void Nack(bool requeue);
        BasicDeliverEventArgs Next();
        bool Next(int millisecondsTimeout, out BasicDeliverEventArgs result);
        bool AutoAck { get; }
        string QueueName { get; }
    }
}
